IPS PowerShell module (Automation cmdlets)

The IPS PowerShell module provides a set of cmdlets that can be used to perform administrative tasks for a Planning Space deployment. You can include the cmdlets in PowerShell scripts to automate tasks.

The module requires at minimum version 3.0 of PowerShell.

(Note for using PowerShell scripts for IPS administration: PowerShell has an ExecutionPolicy setting which is by default set to 'Restricted', which prevents all scripts from running. To use scripts for administration will require setting the ExecutionPolicy to 'RemoteSigned' (as generally recommended by Microsoft) or 'Unrestricted'.)

Installation: IPS Server

The module is installed automatically as part of the IPS Server installation. The files are installed in the 'Palantir' programs folder, for example 'C:\Program Files\Palantir\PalantirIPS 16.5\Powershell', and the Windows environment variable '$env:PSmodulepath' is modified to include this folder. You do not need to do any further installation if you are using the module on an IPS Server machine.

You can test that the module is installed correctly with the following PowerShell command:

Get-Command -Module Palantir.IPS.Manager.Automation

You should see a listing of all of the cmdlets.

Manual installation

Contact Quorum Support if you require the Powershell module as a ZIP file source. The module can also be copied (by a server Administrator) from the IPS Server location shown above.

The ZIP file should have a name in the form 'PalantirIPSManagerAutomation_165Xyyy.zip', where '165' denotes the version number and 'Xyyy' denote the sub-version and build numbers. It is best to use the latest version of the ZIP file which is compatible with your company's Planning Space/IPS deployment, that is having the same version and sub-version numbers.

The installation ZIP file contains two help files (README.txt and INSTALL.txt) and the folder 'Palantir.IPS.Manager.Automation' which contains all of the IPS PowerShell module files.

The folder needs to be installed at some place in your computer's PowerShell lookup path. Your 'PSModulePath' variable for PowerShell should look something like this, by default:

PS> $env:PSmodulepath

C:\Users\{USERNAME}\Documents\WindowsPowerShell\Modules;C:\Program Files\WindowsPowerShell\Modules;C:\Windows\system32\WindowsPowerShell\v1.0\Modules

If you are non-Administrator user, copy the 'Palantir.IPS.Manager.Automation' folder into your own folder 'Documents\WindowsPowerShell\Modules':

1. Create a folder 'C:\Users\{USERNAME}\Documents\WindowsPowerShell\Modules' (if it does not exist).
2. Paste in a copy of the folder 'Palantir.IPS.Manager.Automation'.

If you are an Administrator user, you can make the module available to all users of a machine by adding the 'Palantir.IPS.Manager.Automation' folder to 'C:\Program Files\WindowsPowerShell\Modules'.

You can test that the module is installed correctly with the following PowerShell command:

Get-Command -Module Palantir.IPS.Manager.Automation

You should see a listing of all of the cmdlets.

Using the cmdlets

For explanation of the settings that are covered by the cmdlets, see IPS Server configuration, Licensing and Applications settings.

All of the cmdlets, except for 'Test-Server', require a server login with 'Connect-IPSManager'. For example:

Connect-IPSManager https://ips.mycompany.com

with the output:

 IsSuccess            : True
Errors               : 
Url                  : https://ips.mycompany.com
ServerVersion        : 16.5.0.0
UserName             : MYCOMPANY\ipsadmin
IsMemberOfAdminGroup : True
IsServerLicensed     : True

The authentication of your connection is based on the Windows user account that executes the 'Connect-IPSManager' command. The account must be a member of the IPS Administrators Group. (See Using IPS Manager.)

You should disconnect from the server when the connection is no longer required:

Disconnect-IpsManager

Note on connection to an IPS server cluster: When you connect to a cluster of server machines, you have the option to connect to the load balancer (i.e., by using the service address), which will automatically select one of the server machines to connect to, or to connect directly to a specific server machine. There are a few cmdlets intended for use with specific server machines, when adding or removing machines to/from a cluster, or changing the primary server machine: Get-IsPartOfCluster, Get-IsPrimaryServer, Join-ClusterAsPrimaryServer, and Join-ClusterAsSecondaryServer.

Note on Boolean inputs: The 'true' and 'false' string values should not be used as inputs to Boolean parameters. The inputs '0', '1', '$true' or '$false' should always be used.

Using the module help information

The cmdlets follow the standard PowerShell 'verb-noun' convention.

The module contains comprehensive help information for all of the cmdlets. Use the table of cmdlets below to look up a cmdlet name and then access the help information with 'Get-Help'. For example:

Get-Help Get-TenantClusterTempFolder -full

You can use the Windows Powershell ISE tool to explore the contents of the module: open the Command add-on and in the 'Module' selection box select 'Palantir.IPS.Manager.Automation'.

Cmdlet listing for Palantir.IPS.Manager.Automation

For explanation of the settings that are covered by the cmdlets, see IPS Server configuration, Licensing and Applications settings.